home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 090 / cdir.arc / CDIR.TXT < prev   
Encoding:
Text File  |  1986-02-05  |  11.0 KB  |  314 lines
  1.      _____________________________________________________________________
  2.  
  3.                         ****  COMMENTED DIRECTORY  ****
  4.  
  5.                                   Version 2.0
  6.  
  7.                               by Dennis L. Raney   
  8.      
  9.                    (C) Copyright PC Applications 1985, 1986
  10.      _____________________________________________________________________
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                                   COPY NOTICE
  18.  
  19.          This is a user-supported program and is protected by the federal 
  20.      copyright  laws.  It  is intended for personal use  only.  Commercial 
  21.      users are requested to send a very nominal donation.  It is not to be 
  22.      distributed with any other product or service.  No charge may be made 
  23.      for  its  distribution,  including  any "Disk fee".  Nor  may  it  be
  24.      distributed in any modified form.
  25.          You are encouraged to to distribute this program, whether you use 
  26.      it or not. Support the freeware concept.
  27.  
  28.  
  29.  
  30.  
  31.  
  32.                                  REGISTRATION
  33.  
  34.          This program is provided on an "as is" basis.  No further support
  35.      will  be provided for version two point zero (2.0).  If you like  the 
  36.      program,  and  would like an opportunity to acquire a  more  enhanced 
  37.      version,  along with support, you will need to register as a user. To 
  38.      register  costs  nothing.  As  a registered user,  you  will  receive 
  39.      notices  of enhancements,  and be allowed to receive them for a  very 
  40.      nominal fee,  normally at cost.  There will be no further releases of 
  41.      newer versions to the public domain,  only to registered  users.  New 
  42.      versions  will  only  be released when there has been  a  substantial 
  43.      number  of  enhancements  made  to  the  program.  So  fill  out  the 
  44.      registration  at the end of this document,  and send it in.  It  will 
  45.      cost  you only a stamp to register,  and then it is up to you  as  to
  46.      whether you wish the up graded version.
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.      INTRODUCTION,
  65.  
  66.          In a computer system of any size, it is often very easy to forget 
  67.      what the many programs,  documents,  and various files are. With only 
  68.      eight characters available for file names, it is often hard to create 
  69.      names that are meaningful,  especially when viewed months later. CDir 
  70.      was  created  to alleviate this problem.  With CDir you can create  a 
  71.      file of comments for every program,  document, spreadsheet, etc. that 
  72.      you may have on your disks,  whether you are using floppies or a hard 
  73.      disk. 
  74.  
  75.          You could create a text file of comments on your own. In fact you 
  76.      may have already done such.  If so, you know that recalling a comment 
  77.      from such a file can be tedious at best.  With CDir you will be  able 
  78.      to create a comment for all of your files,  up to 65 characters long, 
  79.      that  can  be easily recalled with a simple command.  There are  some 
  80.      disk library programs,  but these are quite often large programs, and 
  81.      require a large amount of disk memory. With CDir, you only need about 
  82.      3k of storage for the program,  and up to 57k for each comment  file. 
  83.      You  may  have  one master comment file.  You may have one  for  each 
  84.      directory or floppy disk.
  85.  
  86.          You  may find other uses for CDir.  For my own use,  I  sometimes 
  87.      create  comments to show the proper syntax of various  DOS  commands, 
  88.      program  switches,  etc.  The main purpose is to have the information 
  89.      about  a file available when and where you need it  the  most,  right 
  90.      where you are working.   
  91.  
  92.  
  93.      HARDWARE REQUIREMENTS,
  94.  
  95.      These are the minimum requirements of CDir:
  96.      
  97.      * IBM-PC/XT or close compatible.
  98.      * MS-DOS 2.0 or higher version.
  99.      * Minimum of 128k total memory (64k free).
  100.      * Monochrome or Color card.
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.      
  110.  
  111.  
  112.  
  113.  
  114.      USING CDIR,
  115.  
  116.          On  floppy  based systems place a copy of CDIR.COM  on  your  DOS 
  117.      disk. If you are using a RAM disk you can place a copy there when you 
  118.      boot  your system.  On a hard disk system,  place a copy in your  DOS 
  119.      directory,  or wherever, as long as DOS can locate it in the  current 
  120.      path.
  121.  
  122.  
  123.           For  CDir to be usable you must have a comment file in the  root 
  124.      directory of the default disk (CDIR.CMT). If this file is not present 
  125.      you must create it using the /A switch or with a text  processor.  If 
  126.      you use a text processor such as WordStar (tm),  use the non-document 
  127.      mode. The comment file must follow a strict format. 
  128.  
  129.      The format is as follows:
  130.  
  131.      CDIR.COM;Displays a commented directory to the user.
  132.      CDIR.CMT ;Comment file for CDIR.COM program.
  133.  
  134.           The  filename  must  be in upper case letters,  followed  by  an 
  135.      optional space and a semicolon,  then your comment. If the comment is 
  136.      longer  than 65 characters it will wrap around and throw the  display 
  137.      off.  Future versions will correct this,  and allow for a much larger 
  138.      comment.  The  filenames may be kept in alphabetical  order,  but  it 
  139.      makes  no  difference to CDir.  The easiest way to create and add  to 
  140.      your comment file is using CDir with the /A switch, (Append comment). 
  141.      All  CDir  comment  files are easily  edited,  using  any  good  word 
  142.      processor.  As  it stands right now with version 2.0,  you must use a 
  143.      word processor to edit comments,  or delete comments from the comment 
  144.      file.  Once again,  future versions will include these features. This 
  145.      is a usable version,  but newer versions will include these  features 
  146.      and more as they are suggested.
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.      SYNTAX OF CDIR,
  161.  
  162.      The basic syntax of CDir is as follows:
  163.  
  164.      CDIR [d:] [pathname] [filespec] [/x]
  165.  
  166.      [ ] is an optional parameter.
  167.      < > is a necessary parameter.
  168.      [d:] is any allowable drive letter.
  169.      [pathname] is any allowable path name.
  170.      [filespec] is an legal filename. Wild cards may be used, ? and *.
  171.      [/x] is a switch to select several options. (/A, /D, /H, /P, /S).
  172.  
  173.      CDIR SWITCHES,
  174.  
  175.           You  have  several  option  switches  available  with  CDir,  an 
  176.      explanation of them follows.
  177.  
  178.      Switch    Explanation
  179.      ------    -----------
  180.       /A       Appends file comments to the current comment file.  If  the
  181.                comment  file  does  not  exist  CDir  creates  one.   If  a
  182.                comment file exists it renames it with a .BAK extension, and 
  183.                creates a new comment file. CDir will display a filename &
  184.                a comment if one exists. If no comment exists, then CDir 
  185.                will prompt you for one. If you wish to enter a comment, 
  186.                type it in and press return. If you wish to not enter a 
  187.                comment  simply  press  the  return  key.  When  all  files 
  188.                matching the <filespec> have been displayed CDir will write
  189.                the new file to the disk, and display the amount of memory
  190.                left in the comment buffer. (Limit 57k bytes in size).
  191.                This is enough memory to hold about 1,400 average comments.
  192.                Enough to handle a large hard disk system, about 20 meg.
  193.  
  194.       /D       Display subdirectory names also. Normally CDir displays only
  195.                Archive, Archived, and Read only files. If you wish to add
  196.                comments  for subdirectories use the /D switch  along  with 
  197.                the /A switch.
  198.  
  199.       /H       Display hidden files. Used to display hidden disk files.
  200.                Use with the /A switch to create comments for Hidden files.
  201.  
  202.       /S       Display system files. Use with the /A switch to create 
  203.                comments for system files.
  204.  
  205.       /P       Pause display when screen is full. Use this switch when you
  206.                you have a long directory listing.
  207.  
  208.  
  209.  
  210.  
  211.          These switches may be used in any order or combination.  The out 
  212.      put may also be redirected using the DOS redirection commands to send    
  213.      the output to another device, such as the printer, or a disk file, etc.
  214.      For more information on DOS redirection, see your DOS manual.
  215.  
  216.      NOTE:  CDir  may  be used in the default drive and directory  without
  217.      any pathname or file specifier. 
  218.  
  219.      EXAMPLE: CDIR or CDIR /D etc.
  220.      
  221.          This will display all files in the current directory.  To display 
  222.      files  in another directory,  other than the one you're in,  you must 
  223.      provide  a file mask also.  Such as,  CDIR \BASICA\*.BAS,  using  any 
  224.      allowable wild cards. 
  225.  
  226.         You may also use a file name,  such as,  CDIR \ASM\CDIR.COM.  This 
  227.      will display only the selected file. You may use this to add comments 
  228.      or display comments for one file.  
  229.  
  230.        It is recommended that you thoroughly test this program,  to ensure 
  231.      that it will suit your needs. Whether you decide to use it or not, you 
  232.      are encouraged to share it with others. 
  233.  
  234.  
  235.      CDir was written entirely in assembly language using MicroSoft's (tm) 
  236.      Macro Assembler 1.27.  The source code may be purchased by contacting 
  237.      the author at the following address.
  238.  
  239.      Dennis L. Raney
  240.      %PC Applications
  241.      2612 Castle Dr.
  242.      Blue Springs, Mo. 64015
  243.      Phone# (816)229-8699
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.                     Mail to:  PC Applications
  263.                               2612 Castle Drive
  264.                               Blue Springs, Mo. 64015
  265.  
  266.                                REGISTRATION FORM
  267.  
  268.      REQUIRED FOR PERSONAL USE,
  269.  
  270.      NAME  ___________________________________________________________
  271.  
  272.      STREET ADDRESS __________________________________________________
  273.  
  274.      CITY ____________________________  STATE _______  ZIP ___________
  275.  
  276.      HOME PHONE ___________________  
  277.  
  278.  
  279.      REQUIRED FOR BUSINESS USE ONLY,
  280.  
  281.      COMPANY NAME ____________________________________________________
  282.  
  283.      COMPANY STREET ADDRESS __________________________________________
  284.  
  285.      CITY ___________________________  STATE _________  ZIP __________
  286.  
  287.      BUSINESS PHONE __________________
  288.  
  289.  
  290.      MODEL COMPUTER __________________________________________________
  291.  
  292.      DOS VERSION __________________  TOTAL MEMORY INSTALLED __________
  293.  
  294.      NUMBER OF DRIVES _____________  
  295.  
  296.  
  297.      WHAT ADDITIONAL FEATURES WOULD YOU LIKE TO HAVE AVAILABLE IN CDIR. 
  298.  
  299.      __________________________________________________________________
  300.  
  301.      __________________________________________________________________
  302.  
  303.      __________________________________________________________________
  304.  
  305.  
  306.      ANY OTHER COMMENTS _______________________________________________
  307.  
  308.      __________________________________________________________________
  309.  
  310.      __________________________________________________________________
  311.  
  312.      __________________________________________________________________
  313.  
  314.